DOC-1105 RPCN on GCP BYOVPC by asimms41 · Pull Request #238 · redpanda-data/cloud-docs

asimms41 · 2025-03-20T18:12:01Z

Description

Resolves DOC-1105
Review deadline: 2nd April

This pull request introduces several updates to the documentation to support Redpanda Connect for BYOVPC clusters on GCP. The changes include adding new guides, updating prerequisites, and modifying feature availability messages.

This pull request includes several changes to documentation files to update the availability and configuration of Redpanda Connect on BYOVPC clusters, particularly for GCP. The most important changes include adding a new guide for enabling Redpanda Connect on BYOVPC clusters on GCP, updating availability messages, and modifying existing documentation to reflect these updates.

Documentation Updates:

modules/ROOT/nav.adoc: Added a new link to the guide for enabling Redpanda Connect on BYOVPC clusters on GCP.
modules/develop/partials/availability-message.adoc: Updated the availability message to indicate that Redpanda Connect is in beta for BYOVPC clusters on GCP but not available on AWS or Azure.
modules/get-started/pages/cloud-overview.adoc: Updated the list of features in limited availability and beta to include Redpanda Connect for BYOVPC on GCP. [1] [2]

New Guide:

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc: Added a comprehensive guide for enabling Redpanda Connect on an existing BYOVPC cluster on GCP, including steps to create service accounts, bind them, and update the cluster configuration.

Configuration Instructions:

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc: Added detailed instructions for creating and binding service accounts required for Redpanda Connect, and updated the guide to include new permissions and configuration steps. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Availability Message Update:

modules/shared/partials/feature-flag-rpcn.adoc: Updated the feature flag message to reflect the beta availability of Redpanda Connect for BYOVPC clusters on GCP.

Page previews

Create BYOVPC on GCP

Enable Redpanda Connect on a BYOVPC Cluster on GCP

Redpanda Connect Quickstart

Cloud Overview

Checks

New feature
Content gap
Support Follow-up
Small fix (typos, links, copyedits, etc)

hyperlint-ai-deprecated · 2025-03-20T18:12:23Z

PR Change Summary

Enhanced documentation for Redpanda Connect on GCP BYOVPC, including service account creation and configuration steps.

Added instructions for creating Redpanda Connect service accounts and roles.
Included steps to enable Redpanda Connect on existing BYOVPC clusters.
Updated commands for managing IAM policy bindings for service accounts.

Modified Files

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc
modules/networking/pages/gcp-private-service-connect.adoc

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

netlify · 2025-03-20T18:12:26Z

✅ Deploy Preview for rp-cloud ready!

Name	Link
🔨 Latest commit
🔍 Latest deploy log	https://app.netlify.com/sites/rp-cloud/deploys/67efe988ea4a3e1bbc6173e5
😎 Deploy Preview	https://deploy-preview-238--rp-cloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc

modules/networking/pages/gcp-private-service-connect.adoc

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc

tomasz-sadura

Nice

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc

modules/shared/partials/feature-flag-rpcn.adoc

modules/develop/partials/availability-message.adoc

modules/develop/pages/connect/connect-quickstart.adoc

modules/shared/partials/feature-flag-rpcn.adoc

tomasz-sadura

LGTM, thanks!

modules/develop/pages/connect/connect-quickstart.adoc

modules/develop/partials/availability-message.adoc

modules/shared/partials/feature-flag-rpcn.adoc

david-yu · 2025-03-28T07:14:48Z

Still testing the changes here, I have some feedback on BYOVPC in general for docs which we can probably incorporate the entire process seems pretty onerous to the user.

Btw for the Enable RP Connect docs page, is this only for folks that have existing clusters without RP Connect? Also would we ever want to allow folks to disable RP Connect? @tomasz-sadura

tomasz-sadura · 2025-03-28T08:31:47Z

Having scaling from 0 I don't think it will be the case, unless we want to.

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc

david-yu · 2025-03-28T18:45:14Z

@tomasz-sadura

Having scaling from 0 I don't think it will be the case, unless we want to.

I ask because steps one and two are pretty much the same as what's already included in the create BYOVPC cluster as it is for enable connect: https://deploy-preview-238--rp-cloud.netlify.app/redpanda-cloud/get-started/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp/.

Do folks need to enable connect or does cloud enable it for you if you have the SA and bindings already set?

Also to clarify it sounds like turning off Connect is not an option?

david-yu · 2025-03-29T00:07:04Z

Ok just re-read it does look like the second page is to enable RP Connect on an existing cluster. Dis-regard question related to existing versus new clusters.

To enable Redpanda Connect on an existing BYOVPC cluster, you must update your configuration. You can also create a new BYOVPC cluster with Redpanda Connect already enabled.

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc

david-yu

Approved, but would be good to accept the suggestion as the IP addr is wrong and should be 172.16.0.32/28

modules/develop/partials/availability-message.adoc

modules/shared/partials/feature-flag-rpcn.adoc

JakeSCahill

LGTM. Nice additions 😄

modules/get-started/pages/cloud-overview.adoc

draft process

ffcd8b8

asimms41 commented Mar 20, 2025

View reviewed changes

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc Show resolved Hide resolved

asimms41 commented Mar 20, 2025

View reviewed changes

modules/networking/pages/gcp-private-service-connect.adoc Outdated Show resolved Hide resolved

asimms41 commented Mar 20, 2025

View reviewed changes

modules/networking/pages/gcp-private-service-connect.adoc Outdated Show resolved Hide resolved

asimms41 commented Mar 20, 2025

View reviewed changes

modules/networking/pages/gcp-private-service-connect.adoc Outdated Show resolved Hide resolved

asimms41 commented Mar 20, 2025

View reviewed changes

modules/networking/pages/gcp-private-service-connect.adoc Outdated Show resolved Hide resolved

asimms41 requested a review from tomasz-sadura March 20, 2025 18:22

tomasz-sadura reviewed Mar 21, 2025

View reviewed changes

added new page and updated config inline with review

da7fc3e

asimms41 requested a review from tomasz-sadura March 24, 2025 09:22

tomasz-sadura approved these changes Mar 24, 2025

View reviewed changes

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc Outdated Show resolved Hide resolved

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc Outdated Show resolved Hide resolved

tomasz-sadura requested changes Mar 24, 2025

View reviewed changes

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc Show resolved Hide resolved

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc Show resolved Hide resolved

tomasz-sadura reviewed Mar 24, 2025

View reviewed changes

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc Outdated Show resolved Hide resolved

tomasz-sadura reviewed Mar 24, 2025

View reviewed changes

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc Outdated Show resolved Hide resolved

tomasz-sadura requested changes Mar 25, 2025

View reviewed changes

asimms41 added 2 commits March 25, 2025 10:04

dev review comments

dbe3437

Merge branch 'main' into DOC-1105_GCP_on_BYOVPC

8165e13

hyperlint-ai-deprecated bot reviewed Mar 25, 2025

View reviewed changes

update quickstart

cad67b6

hyperlint-ai-deprecated bot reviewed Mar 25, 2025

View reviewed changes

modules/develop/pages/connect/connect-quickstart.adoc Outdated Show resolved Hide resolved

modules/shared/partials/feature-flag-rpcn.adoc Outdated Show resolved Hide resolved

asimms41 requested a review from tomasz-sadura March 25, 2025 10:44

Hyperlint reviews

782dada

tomasz-sadura approved these changes Mar 25, 2025

View reviewed changes

asimms41 marked this pull request as ready for review March 25, 2025 11:03

asimms41 requested a review from a team as a code owner March 25, 2025 11:03

asimms41 requested a review from jrkinley March 25, 2025 11:03

updates for consistency

8274252

asimms41 commented Mar 25, 2025

View reviewed changes

modules/develop/pages/connect/connect-quickstart.adoc Outdated Show resolved Hide resolved

asimms41 requested a review from david-yu March 26, 2025 09:07

jrkinley suggested changes Mar 27, 2025

View reviewed changes

modules/develop/pages/connect/connect-quickstart.adoc Outdated Show resolved Hide resolved

modules/develop/partials/availability-message.adoc Outdated Show resolved Hide resolved

modules/shared/partials/feature-flag-rpcn.adoc Outdated Show resolved Hide resolved

review comments

7dbc3a7

asimms41 commented Mar 28, 2025

View reviewed changes

modules/get-started/pages/cluster-types/byoc/gcp/enable-rpcn-byovpc-gcp.adoc Show resolved Hide resolved

asimms41 requested a review from jrkinley March 28, 2025 10:30

asimms41 added 3 commits April 1, 2025 09:50

add missing role, reordering, update role bindings to double quotes

2491581

add text about placeholders

a57fc8a

PM review comments

25c8a40

david-yu reviewed Apr 1, 2025

View reviewed changes

modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc Outdated Show resolved Hide resolved

david-yu approved these changes Apr 1, 2025

View reviewed changes

asimms41 added 2 commits April 2, 2025 10:33

Added detail on GKE master CIDR range

e16f4e7

Add region to addresses command

04859e9

david-yu approved these changes Apr 3, 2025

View reviewed changes

jrkinley approved these changes Apr 4, 2025

View reviewed changes

modules/develop/partials/availability-message.adoc Show resolved Hide resolved

modules/shared/partials/feature-flag-rpcn.adoc Outdated Show resolved Hide resolved

Update feature flag message

3b9b307

JakeSCahill approved these changes Apr 4, 2025

View reviewed changes

micheleRP reviewed Apr 4, 2025

View reviewed changes

modules/get-started/pages/cloud-overview.adoc Outdated Show resolved Hide resolved

micheleRP reviewed Apr 4, 2025

View reviewed changes

modules/get-started/pages/cloud-overview.adoc Outdated Show resolved Hide resolved

docs review comments

55c235b

asimms41 requested a review from micheleRP April 4, 2025 13:47

rewording

29b0eb0

asimms41 merged commit f3c0a5a into main Apr 4, 2025
7 checks passed

asimms41 deleted the DOC-1105_GCP_on_BYOVPC branch April 4, 2025 14:20

Conversation

asimms41 commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Documentation Updates:

New Guide:

Configuration Instructions:

Availability Message Update:

Page previews

Checks

Uh oh!

hyperlint-ai-deprecated bot commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Change Summary

Uh oh!

netlify bot commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for rp-cloud ready!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tomasz-sadura left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tomasz-sadura left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

david-yu commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tomasz-sadura commented Mar 28, 2025

Uh oh!

Uh oh!

david-yu commented Mar 28, 2025

Uh oh!

david-yu commented Mar 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

david-yu left a comment

Choose a reason for hiding this comment

asimms41 commented Mar 20, 2025 •

edited

Loading

hyperlint-ai-deprecated bot commented Mar 20, 2025 •

edited

Loading

netlify bot commented Mar 20, 2025 •

edited

Loading

david-yu commented Mar 28, 2025 •

edited

Loading

david-yu commented Mar 29, 2025 •

edited

Loading